Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cache for sqlite method calls to prevent duplicate writes #207

Merged
merged 4 commits into from
Sep 20, 2024

Conversation

karlprieb
Copy link
Collaborator

Add a cache for saveNestedDataHash calls to prevent duplicate writes. Add a metrics counter for the number of duplicate saveNestedDataHash calls.

In an environment with ~830 calls to saveNestedDataHash per second after 7 minutes of operation(cache entry TTL), the amount of cached keys was ~349k, with a total of ~33MB of data stored in the cache.

Total amount of duplicated calls was 1428.

Add a cache for saveNestedDataHash calls to prevent duplicate writes.
Add a metrics counter for the number of duplicate saveNestedDataHash calls.

In an environment with ~830 calls to saveNestedDataHash per second after
7 minutes of operation(cache entry TTL), the amount of cached keys was
~349k, with a total of ~33MB of data stored in the cache.

Total amount of duplicated calls was 1428.
Copy link

codecov bot commented Sep 18, 2024

Codecov Report

Attention: Patch coverage is 54.00000% with 23 lines in your changes missing coverage. Please review.

Project coverage is 70.09%. Comparing base (d685d92) to head (089ee33).
Report is 5 commits behind head on develop.

Files with missing lines Patch % Lines
src/database/standalone-sqlite.ts 47.72% 23 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #207      +/-   ##
===========================================
- Coverage    70.13%   70.09%   -0.05%     
===========================================
  Files           32       32              
  Lines         7834     7877      +43     
  Branches       438      429       -9     
===========================================
+ Hits          5494     5521      +27     
- Misses        2340     2356      +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@karlprieb karlprieb changed the title cache for saveNestedDataHash calls to prevent duplicate writes cache for sqlite method calls to prevent duplicate writes Sep 18, 2024
@karlprieb karlprieb marked this pull request as ready for review September 18, 2024 18:27
Copy link
Contributor

coderabbitai bot commented Sep 18, 2024

Walkthrough

Walkthrough

The changes introduce caching mechanisms in the StandaloneSqliteDatabaseWorker and StandaloneSqliteDatabase classes to optimize data insertion operations and prevent duplicate entries. New caches are implemented to track data hashes and content attributes, along with a new metric to monitor duplicate save attempts. These modifications aim to enhance the efficiency of database operations and improve monitoring capabilities.

Changes

File Path Change Summary
src/database/standalone-sqlite.ts Introduced caching mechanisms using NodeCache to prevent duplicate insertions and saves. Added caches: insertDataHashCache and saveDataContentAttributesCache.
src/metrics.ts Added a new metric counter saveMethodsDuplicateCounter to track duplicate calls to save methods.

Possibly related PRs

  • Release 16 fixes and prep #183: The main PR introduces caching mechanisms to prevent duplicate database operations, while PR Release 16 fixes and prep #183 adds a new Prometheus counter to track the total number of data items indexed, which relates to the overall goal of improving database efficiency and monitoring.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9a4e827 and 089ee33.

Files selected for processing (1)
  • src/database/standalone-sqlite.ts (8 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/database/standalone-sqlite.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@@ -2924,6 +2968,17 @@ export class StandaloneSqliteDatabase
parentId: string;
dataOffset: number;
}): Promise<void> {
const key = `${hash}:${parentId}`;

if (this.saveNestedDataHashCache.get(key)) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PiKNiK testing matches your test results, @karlprieb. We see some bursts of duplicates, but overall there aren't many here. Let's remove the deduplication here and save some memory.

Copy link
Collaborator

@djwhitt djwhitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 out of 3 look effective. Let's remove the deduplication for saveNestedDataHash, but keep the rest.

@djwhitt djwhitt merged commit 878fde0 into develop Sep 20, 2024
4 checks passed
@djwhitt djwhitt deleted the PE-6724-dedup-data-db-inserts branch September 20, 2024 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants